docs: remove Ineffective code block #20703
Conversation
WalkthroughWalkthroughThe recent change involves the removal of a code snippet related to Gogoproto in the documentation file Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (7)
docs/learn/advanced/05-encoding.md (7)
Line range hint
151-151: Consider using "take a look" instead of "Have a look" to adhere to American English conventions.- Have a look at [a real-life example in the x/auth module] + Take a look at [a real-life example in the x/auth module]
Line range hint
205-205: Consider revising the phrase to avoid wordiness.- we made the decision to not include such prefix + we decided not to include such prefix
Line range hint
258-258: Consider using a more expressive verb than "do".- To do that, a module-level .proto file must use + To achieve that, a module-level .proto file must use
Line range hint
260-260: Add a comma after "file" for better readability.- In the proto file we define it as follows: + In the proto file, we define it as follows:
Line range hint
271-271: Replace "to" with "for" for grammatical correctness.- to easy encoding of state to `Any`. + for easy encoding of state to `Any`.
Line range hint
222-223: Replace hard tabs with spaces to comply with Markdownlint rules.- <tab>message MsgSubmitEvidence { - <tab><tab>submitter = 1; + message MsgSubmitEvidence { + submitter = 1;
[!TIP]
Codebase VerificationAll documents in the
docs/learn/advanceddirectory have the samesidebar_position: 1. This needs to be corrected to ensure each document has a uniquesidebar_positionto maintain the correct order and structure of the documentation.
docs/learn/advanced/00-baseapp.mddocs/learn/advanced/01-transactions.mddocs/learn/advanced/02-context.mddocs/learn/advanced/03-node.mddocs/learn/advanced/04-store.mddocs/learn/advanced/05-encoding.mddocs/learn/advanced/06-grpc_rest.mddocs/learn/advanced/07-cli.mddocs/learn/advanced/08-events.mddocs/learn/advanced/09-telemetry.mddocs/learn/advanced/10-ocap.mddocs/learn/advanced/11-runtx_middleware.mddocs/learn/advanced/12-simulation.mddocs/learn/advanced/13-proto-docs.mddocs/learn/advanced/15-upgrade.mddocs/learn/advanced/16-config.mdEach of these files should be assigned a unique
sidebar_positionfrom 0 to 15 to reflect their order.Analysis chain
Line range hint
1-1: Ensure thesidebar_positionmetadata is correctly set for this document's position in the documentation structure.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check other documents for their sidebar_position to ensure no duplicates or skips. # Test: List all sidebar_position in the same directory. rg 'sidebar_position:' $(dirname $(fd --type f '05-encoding.md'))Length of output: 994
Script:
#!/bin/bash # Description: List all files in the directory and their sidebar_position values to understand the correct order. # List all files and their sidebar_position values in the directory. for file in $(fd --type f .md docs/learn/advanced); do echo "$file: $(rg 'sidebar_position:' $file | cut -d' ' -f2)" doneLength of output: 3447
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/advanced/05-encoding.md (1 hunks)
Additional context used
Path-based instructions (1)
docs/learn/advanced/05-encoding.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
LanguageTool
docs/learn/advanced/05-encoding.md
[locale-violation] ~151-~151: In American English, “take a look” is more commonly used. (HAVE_A_LOOK)
Context: ...face` method to bundle these two steps. Have a look at [a real-life example in the x/auth m...
[style] ~205-~205: Consider shortening this phrase to avoid wordiness. (MAKE_THE_CHOICE_TO)
Context: ...87-L91). However, in the Cosmos SDK, we made the decision to not include such prefix, to have sho...
[style] ~258-~258: Consider a more expressive alternative. (DO_ACHIEVE)
Context: ...k.Any(from/types` package) type. To do that, a module-level .proto file must u...
[uncategorized] ~260-~260: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...to wrap the evidence file. In the proto file we define it as follows: ```protobuf /...
[uncategorized] ~271-~271: The preposition ‘for’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_TO_FOR)
Context: ...shalInterfaceandUnmarshalInterfaceto easy encoding of state toAny`. Modul...
Markdownlint
docs/learn/advanced/05-encoding.md
61-61: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
62-62: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
64-64: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
65-65: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
222-222: Column: 3 (MD010, no-hard-tabs)
Hard tabs
223-223: Column: 2 (MD010, no-hard-tabs)
Hard tabs
julienrbrt
added
the
backport/v0.50.x
(cherry picked from commit 3a21ceb)
* build(deps): Bump github.com/cosmos/gogoproto from 1.4.12 to 1.5.0 (cosmos#20567) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * refactor(x/authz,x/feegrant): provide updated keeper in depinject (cosmos#20590) * docs: Update high level overview and introduction (backport cosmos#20535) (cosmos#20627) Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * fix: Properly parse json in the wait-tx command. (backport cosmos#20631) (cosmos#20660) Co-authored-by: Daniel Wedul <github@wedul.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * docs: remove Ineffective code block (backport cosmos#20703) (cosmos#20711) * feat(client): Add flag & reading mnemonic from file (backport cosmos#20690) (cosmos#20712) Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * fix: nested multisig signatures using CLI (backport cosmos#20438) (cosmos#20692) Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Facundo <facundomedica@gmail.com> * feat(client/v2): get keyring from context (backport cosmos#19646) (cosmos#20727) Co-authored-by: Julien Robert <julien@rbrt.fr> * docs(x/group): orm codespace comment (backport cosmos#20749) (cosmos#20751) * feat: parse home flag earlier (backport cosmos#20771) (cosmos#20777) Co-authored-by: Julien Robert <julien@rbrt.fr> * build(deps): Bump github.com/cometbft/cometbft from 0.38.7 to 0.38.8 (cosmos#20805) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * build(deps): Bump github.com/cometbft/cometbft from 0.38.8 to 0.38.9 (cosmos#20836) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * fix(simulation): fix the problem of `validator set is empty after InitGenesis` in simulation test (backport cosmos#18196) (cosmos#20897) Co-authored-by: Chenqun Lu <luchenqun@qq.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * fix(simulation): Fix all problems `make test-sim-custom-genesis-fast` for simulation test. (backport cosmos#17911) (cosmos#20909) Co-authored-by: Chenqun Lu <luchenqun@qq.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * chore: prepare v0.50.8 (cosmos#20910) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Daniel Wedul <github@wedul.com> Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com> Co-authored-by: Facundo <facundomedica@gmail.com> Co-authored-by: Chenqun Lu <luchenqun@qq.com>
Description
Remove Ineffective code block
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit